<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>psychsim.pwl</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="psychsim.world.World-class.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://pynadath.net:81/projects/psychsim">PsychSim</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="psychsim-module.html">Package&nbsp;psychsim</a> ::
        Module&nbsp;pwl
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="psychsim.pwl-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module pwl</h1><p class="nomargin-top"><span class="codelink"><a href="psychsim.pwl-pysrc.html">source&nbsp;code</a></span></p>
<p>Class and function definitions for PieceWise Linear (PWL) 
  representations</p>

<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Classes"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="psychsim.pwl.KeyedVector-class.html" class="summary-name">KeyedVector</a><br />
      Class for a compact, string-indexable vector
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="psychsim.pwl.VectorDistribution-class.html" class="summary-name">VectorDistribution</a><br />
      A class representing a <a 
        href="psychsim.probability.Distribution-class.html" 
        class="link">Distribution</a> over <a 
        href="psychsim.pwl.KeyedVector-class.html" 
        class="link">KeyedVector</a> instances
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="psychsim.pwl.KeyedMatrix-class.html" class="summary-name">KeyedMatrix</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="psychsim.pwl.MatrixDistribution-class.html" class="summary-name">MatrixDistribution</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="psychsim.pwl.KeyedPlane-class.html" class="summary-name">KeyedPlane</a><br />
      String indexable hyperplane class
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="psychsim.pwl.KeyedTree-class.html" class="summary-name">KeyedTree</a><br />
      Decision tree node using symbolic PWL structures
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="psychsim.pwl.TreeDistribution-class.html" class="summary-name">TreeDistribution</a><br />
      A class representing a <a 
        href="psychsim.probability.Distribution-class.html" 
        class="link">Distribution</a> over <a 
        href="psychsim.pwl.KeyedTree-class.html" class="link">KeyedTree</a>
        instances
    </td>
  </tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="psychsim.pwl.KeyedMatrix-class.html" 
      class="link">KeyedMatrix</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="psychsim.pwl-module.html#scaleMatrix" class="summary-sig-name">scaleMatrix</a>(<span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">weight</span>)</span><br />
      Returns:
      a dynamics matrix modifying the given keyed value by scaling it by 
      the given weight</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#scaleMatrix">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="psychsim.pwl.KeyedMatrix-class.html" 
      class="link">KeyedMatrix</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="psychsim.pwl-module.html#noChangeMatrix" class="summary-sig-name">noChangeMatrix</a>(<span class="summary-sig-arg">key</span>)</span><br />
      Returns:
      a dynamics matrix indicating no change to the given keyed value</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#noChangeMatrix">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="psychsim.pwl.KeyedMatrix-class.html" 
      class="link">KeyedMatrix</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="psychsim.pwl-module.html#approachMatrix" class="summary-sig-name">approachMatrix</a>(<span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">weight</span>,
        <span class="summary-sig-arg">limit</span>)</span><br />
      Returns:
      a dynamics matrix modifying the given keyed value by approaching the 
      given limit by the given weighted percentage of distance</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#approachMatrix">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="psychsim.pwl.KeyedMatrix-class.html" 
      class="link">KeyedMatrix</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="psychsim.pwl-module.html#incrementMatrix" class="summary-sig-name">incrementMatrix</a>(<span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">delta</span>)</span><br />
      Returns:
      a dynamics matrix incrementing the given keyed value by the constant 
      delta</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#incrementMatrix">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="psychsim.pwl.KeyedMatrix-class.html" 
      class="link">KeyedMatrix</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="psychsim.pwl-module.html#setToConstantMatrix" class="summary-sig-name">setToConstantMatrix</a>(<span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">value</span>)</span><br />
      Returns:
      a dynamics matrix setting the given keyed value to the constant value</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#setToConstantMatrix">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="psychsim.pwl.KeyedMatrix-class.html" 
      class="link">KeyedMatrix</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="psychsim.pwl-module.html#setToFeatureMatrix" class="summary-sig-name">setToFeatureMatrix</a>(<span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">otherKey</span>,
        <span class="summary-sig-arg">pct</span>=<span class="summary-sig-default">1.0</span>,
        <span class="summary-sig-arg">shift</span>=<span class="summary-sig-default">0.0</span>)</span><br />
      Returns:
      a dynamics matrix setting the given keyed value to a percentage of 
      another keyed value plus a constant shift (default is 100% with shift
      of 0)</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#setToFeatureMatrix">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="psychsim.pwl.KeyedMatrix-class.html" 
      class="link">KeyedMatrix</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="psychsim.pwl-module.html#addFeatureMatrix" class="summary-sig-name">addFeatureMatrix</a>(<span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">otherKey</span>,
        <span class="summary-sig-arg">pct</span>=<span class="summary-sig-default">1.0</span>)</span><br />
      Returns:
      a dynamics matrix adding a percentage of another feature value to the
      given feature value (default percentage is 100%)</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#addFeatureMatrix">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="setTrueMatrix"></a><span class="summary-sig-name">setTrueMatrix</span>(<span class="summary-sig-arg">key</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#setTrueMatrix">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="setFalseMatrix"></a><span class="summary-sig-name">setFalseMatrix</span>(<span class="summary-sig-arg">key</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#setFalseMatrix">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="psychsim.pwl.KeyedPlane-class.html" 
      class="link">KeyedPlane</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="psychsim.pwl-module.html#thresholdRow" class="summary-sig-name">thresholdRow</a>(<span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">threshold</span>)</span><br />
      Returns:
      a plane testing whether the given keyed value exceeds the given 
      threshold</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#thresholdRow">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="psychsim.pwl.KeyedPlane-class.html" 
      class="link">KeyedPlane</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="psychsim.pwl-module.html#differenceRow" class="summary-sig-name">differenceRow</a>(<span class="summary-sig-arg">key1</span>,
        <span class="summary-sig-arg">key2</span>,
        <span class="summary-sig-arg">threshold</span>)</span><br />
      Returns:
      a plane testing whether the difference between the first and second 
      keyed values exceeds the given threshold</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#differenceRow">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="psychsim.pwl.KeyedPlane-class.html" 
      class="link">KeyedPlane</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="psychsim.pwl-module.html#greaterThanRow" class="summary-sig-name">greaterThanRow</a>(<span class="summary-sig-arg">key1</span>,
        <span class="summary-sig-arg">key2</span>)</span><br />
      Returns:
      a plane testing whether the first keyed value is greater than the 
      second</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#greaterThanRow">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="psychsim.pwl.KeyedPlane-class.html" 
      class="link">KeyedPlane</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="psychsim.pwl-module.html#trueRow" class="summary-sig-name">trueRow</a>(<span class="summary-sig-arg">key</span>)</span><br />
      Returns:
      a plane testing whether a boolean keyed value is True</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#trueRow">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="psychsim.pwl.KeyedPlane-class.html" 
      class="link">KeyedPlane</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="psychsim.pwl-module.html#equalRow" class="summary-sig-name">equalRow</a>(<span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">value</span>)</span><br />
      Returns:
      a plane testing whether the given keyed value equals the given target
      value</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#equalRow">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="maximizeFeature"></a><span class="summary-sig-name">maximizeFeature</span>(<span class="summary-sig-arg">key</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#maximizeFeature">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="minimizeFeature"></a><span class="summary-sig-name">minimizeFeature</span>(<span class="summary-sig-arg">key</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#minimizeFeature">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="makeTree"></a><span class="summary-sig-name">makeTree</span>(<span class="summary-sig-arg">table</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="psychsim.pwl-pysrc.html#makeTree">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="CONSTANT"></a><span class="summary-name">CONSTANT</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'psychsim'"><code class="variable-quote">'</code><code class="variable-string">psychsim</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="scaleMatrix"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">scaleMatrix</span>(<span class="sig-arg">key</span>,
        <span class="sig-arg">weight</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="psychsim.pwl-pysrc.html#scaleMatrix">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Returns: <a href="psychsim.pwl.KeyedMatrix-class.html" 
      class="link">KeyedMatrix</a></dt>
        <dd>a dynamics matrix modifying the given keyed value by scaling it 
          by the given weight</dd>
  </dl>
</td></tr></table>
</div>
<a name="noChangeMatrix"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">noChangeMatrix</span>(<span class="sig-arg">key</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="psychsim.pwl-pysrc.html#noChangeMatrix">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Returns: <a href="psychsim.pwl.KeyedMatrix-class.html" 
      class="link">KeyedMatrix</a></dt>
        <dd>a dynamics matrix indicating no change to the given keyed value</dd>
  </dl>
</td></tr></table>
</div>
<a name="approachMatrix"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">approachMatrix</span>(<span class="sig-arg">key</span>,
        <span class="sig-arg">weight</span>,
        <span class="sig-arg">limit</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="psychsim.pwl-pysrc.html#approachMatrix">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>weight</code></strong> (float) - the percentage by which you want the feature to approach the 
          limit</li>
        <li><strong class="pname"><code>limit</code></strong> (float) - the value you want the feature to approach</li>
    </ul></dd>
    <dt>Returns: <a href="psychsim.pwl.KeyedMatrix-class.html" 
      class="link">KeyedMatrix</a></dt>
        <dd>a dynamics matrix modifying the given keyed value by approaching 
          the given limit by the given weighted percentage of distance</dd>
  </dl>
</td></tr></table>
</div>
<a name="incrementMatrix"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">incrementMatrix</span>(<span class="sig-arg">key</span>,
        <span class="sig-arg">delta</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="psychsim.pwl-pysrc.html#incrementMatrix">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>delta</code></strong> (float) - the constant value to add to the state feature</li>
    </ul></dd>
    <dt>Returns: <a href="psychsim.pwl.KeyedMatrix-class.html" 
      class="link">KeyedMatrix</a></dt>
        <dd>a dynamics matrix incrementing the given keyed value by the 
          constant delta</dd>
  </dl>
</td></tr></table>
</div>
<a name="setToConstantMatrix"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">setToConstantMatrix</span>(<span class="sig-arg">key</span>,
        <span class="sig-arg">value</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="psychsim.pwl-pysrc.html#setToConstantMatrix">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>value</code></strong> (float)</li>
    </ul></dd>
    <dt>Returns: <a href="psychsim.pwl.KeyedMatrix-class.html" 
      class="link">KeyedMatrix</a></dt>
        <dd>a dynamics matrix setting the given keyed value to the constant 
          value</dd>
  </dl>
</td></tr></table>
</div>
<a name="setToFeatureMatrix"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">setToFeatureMatrix</span>(<span class="sig-arg">key</span>,
        <span class="sig-arg">otherKey</span>,
        <span class="sig-arg">pct</span>=<span class="sig-default">1.0</span>,
        <span class="sig-arg">shift</span>=<span class="sig-default">0.0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="psychsim.pwl-pysrc.html#setToFeatureMatrix">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>otherKey</code></strong> (str)</li>
    </ul></dd>
    <dt>Returns: <a href="psychsim.pwl.KeyedMatrix-class.html" 
      class="link">KeyedMatrix</a></dt>
        <dd>a dynamics matrix setting the given keyed value to a percentage 
          of another keyed value plus a constant shift (default is 100% 
          with shift of 0)</dd>
  </dl>
</td></tr></table>
</div>
<a name="addFeatureMatrix"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">addFeatureMatrix</span>(<span class="sig-arg">key</span>,
        <span class="sig-arg">otherKey</span>,
        <span class="sig-arg">pct</span>=<span class="sig-default">1.0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="psychsim.pwl-pysrc.html#addFeatureMatrix">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>otherKey</code></strong> (str)</li>
    </ul></dd>
    <dt>Returns: <a href="psychsim.pwl.KeyedMatrix-class.html" 
      class="link">KeyedMatrix</a></dt>
        <dd>a dynamics matrix adding a percentage of another feature value to
          the given feature value (default percentage is 100%)</dd>
  </dl>
</td></tr></table>
</div>
<a name="thresholdRow"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">thresholdRow</span>(<span class="sig-arg">key</span>,
        <span class="sig-arg">threshold</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="psychsim.pwl-pysrc.html#thresholdRow">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Returns: <a href="psychsim.pwl.KeyedPlane-class.html" 
      class="link">KeyedPlane</a></dt>
        <dd>a plane testing whether the given keyed value exceeds the given 
          threshold</dd>
  </dl>
</td></tr></table>
</div>
<a name="differenceRow"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">differenceRow</span>(<span class="sig-arg">key1</span>,
        <span class="sig-arg">key2</span>,
        <span class="sig-arg">threshold</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="psychsim.pwl-pysrc.html#differenceRow">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Returns: <a href="psychsim.pwl.KeyedPlane-class.html" 
      class="link">KeyedPlane</a></dt>
        <dd>a plane testing whether the difference between the first and 
          second keyed values exceeds the given threshold</dd>
  </dl>
</td></tr></table>
</div>
<a name="greaterThanRow"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">greaterThanRow</span>(<span class="sig-arg">key1</span>,
        <span class="sig-arg">key2</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="psychsim.pwl-pysrc.html#greaterThanRow">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Returns: <a href="psychsim.pwl.KeyedPlane-class.html" 
      class="link">KeyedPlane</a></dt>
        <dd>a plane testing whether the first keyed value is greater than the
          second</dd>
  </dl>
</td></tr></table>
</div>
<a name="trueRow"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">trueRow</span>(<span class="sig-arg">key</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="psychsim.pwl-pysrc.html#trueRow">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Returns: <a href="psychsim.pwl.KeyedPlane-class.html" 
      class="link">KeyedPlane</a></dt>
        <dd>a plane testing whether a boolean keyed value is True</dd>
  </dl>
</td></tr></table>
</div>
<a name="equalRow"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">equalRow</span>(<span class="sig-arg">key</span>,
        <span class="sig-arg">value</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="psychsim.pwl-pysrc.html#equalRow">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Returns: <a href="psychsim.pwl.KeyedPlane-class.html" 
      class="link">KeyedPlane</a></dt>
        <dd>a plane testing whether the given keyed value equals the given 
          target value</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="psychsim.world.World-class.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://pynadath.net:81/projects/psychsim">PsychSim</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed Oct 24 21:38:09 2012
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
